<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxBroadPhaseRegion Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structPxBroadPhaseRegion.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structPxBroadPhaseRegion-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxBroadPhaseRegion Struct Reference<div class="ingroups"><a class="el" href="group__physics.html">Physics</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>"Region of interest" for the broad-phase.  
 <a href="structPxBroadPhaseRegion.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxBroadPhase_8h_source.html">PxBroadPhase.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for PxBroadPhaseRegion:</div>
<div class="dyncontent">
<div class="center"><img src="structPxBroadPhaseRegion__coll__graph.png" border="0" usemap="#PxBroadPhaseRegion_coll__map" alt="Collaboration graph"/></div>
<map name="PxBroadPhaseRegion_coll__map" id="PxBroadPhaseRegion_coll__map">
<area shape="rect" id="node2" href="classPxBounds3.html" title="Class representing 3D range or axis aligned bounding box. " alt="" coords="35,109,125,136"/>
<area shape="rect" id="node3" href="classPxVec3.html" title="3 Element vector class. " alt="" coords="46,5,114,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae13e89ca861565e52680e073da3e4043"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPxBounds3.html">PxBounds3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBroadPhaseRegion.html#ae13e89ca861565e52680e073da3e4043">bounds</a></td></tr>
<tr class="memdesc:ae13e89ca861565e52680e073da3e4043"><td class="mdescLeft">&#160;</td><td class="mdescRight">Region's bounds.  <a href="#ae13e89ca861565e52680e073da3e4043">More...</a><br /></td></tr>
<tr class="separator:ae13e89ca861565e52680e073da3e4043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71ea61caf0560a874bd7fb53cea525b4"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPxBroadPhaseRegion.html#a71ea61caf0560a874bd7fb53cea525b4">userData</a></td></tr>
<tr class="memdesc:a71ea61caf0560a874bd7fb53cea525b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Region's user-provided data.  <a href="#a71ea61caf0560a874bd7fb53cea525b4">More...</a><br /></td></tr>
<tr class="separator:a71ea61caf0560a874bd7fb53cea525b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>"Region of interest" for the broad-phase. </p>
<p>This is currently only used for the <a class="el" href="structPxBroadPhaseType.html#ac7422f895533bff02d0043d35a2b7ddaabe0a5c309436a84e58c227c548fa17da" title="Multi box pruning. ">PxBroadPhaseType::eMBP</a> broad-phase, which requires zones or regions to be defined when the simulation starts in order to work. Regions can overlap and be added or removed at runtime, but at least one region needs to be defined when the scene is created.</p>
<p>If objects that do no overlap any region are inserted into the scene, they will not be added to the broad-phase and thus collisions will be disabled for them. A <a class="el" href="classPxBroadPhaseCallback.html" title="Broad-phase callback to receive broad-phase related events. ">PxBroadPhaseCallback</a> out-of-bounds notification will be sent for each one of those objects.</p>
<p>The total number of regions is limited by <a class="el" href="structPxBroadPhaseCaps.html#aeff3784c87ac5de06aa45e086724df23" title="Max number of regions supported by the broad-phase. ">PxBroadPhaseCaps::maxNbRegions</a>.</p>
<p>The number of regions has a direct impact on performance and memory usage, so it is recommended to experiment with various settings to find the best combination for your game. A good default setup is to start with global bounds around the whole world, and subdivide these bounds into 4*4 regions. The <a class="el" href="classPxBroadPhaseExt.html#a24301db187094029361f8d63fda7c274" title="Creates regions for PxSceneDesc, from a global box. ">PxBroadPhaseExt::createRegionsFromWorldBounds</a> function can do that for you.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxBroadPhaseCallback.html" title="Broad-phase callback to receive broad-phase related events. ">PxBroadPhaseCallback</a> <a class="el" href="classPxBroadPhaseExt.html#a24301db187094029361f8d63fda7c274" title="Creates regions for PxSceneDesc, from a global box. ">PxBroadPhaseExt.createRegionsFromWorldBounds</a> </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="ae13e89ca861565e52680e073da3e4043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae13e89ca861565e52680e073da3e4043">&#9670;&nbsp;</a></span>bounds</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classPxBounds3.html">PxBounds3</a> PxBroadPhaseRegion::bounds</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Region's bounds. </p>

</div>
</div>
<a id="a71ea61caf0560a874bd7fb53cea525b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71ea61caf0560a874bd7fb53cea525b4">&#9670;&nbsp;</a></span>userData</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* PxBroadPhaseRegion::userData</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Region's user-provided data. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="PxBroadPhase_8h_source.html">PxBroadPhase.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structPxBroadPhaseRegion.html">PxBroadPhaseRegion</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
